<!-- Copyright 2017 Capital One Services, LLC and Bitwise, Inc.
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
 http://www.apache.org/licenses/LICENSE-2.0
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License. -->
 
 
<!doctype html>
<html>
<head>
	<title>Output File Fixed Width Properties</title>
	<link rel="stylesheet" type="text/css" href="../../css/style.css">
</head>
<body>
	<p><span class="header-1">Output File Fixed Width Properties</p>
	<p><span>Properties&nbsp;for the Output File Fixed Width component can be viewed by Double click-&gt;component on canvas. The
		properties contain a 'General' tab and a 'Schema' tab. Common and mandatory properties are present in the General tab. Schema
		displays option to accept the field schema i.e. field name, Data type, scale etc.</p>
	<p><a name="general_properties"></a><span class="header-2">General Properties:</p>
	<p>
		<img src="../../images/Output_File_Fixed_Width_Properties_General.png" alt="" />
	</p>
	<p><a name="display"></a><span class="header-2">Display</p>
	<ul>
		<li><span><b>Name - </b>The Name field will specify the name of the component as desired by the user.</li>
		<li><span><b>ID</b> - ID field will specify unique id for every component. </span></li>
		<li><span><b>Type - </b>Type further categorizes the component to detailed operation that it intends to perform. Here it is of type
			File Fixed Width.</li>
	</ul>
	<p><a name="configuration"></a><span class="header-2">Configuration</p>
	<ul>
		<ul>
			<li><span><b>File Path - </b>File path is used to specify the path where the Output fixed width file will be written after execution.
				User can either manually type the path in the text box provided or use the Browse button to search for the file and select
				it. Alternatively, the user can parameterize the File path where the parameter value will be resolved at run-time.</li>
			<li><span><b>Overwrite - </b>This property accepts Boolean values True and False. It can also be parameterized and later on resolved
				during run-time. The Overwrite property when True, overwrites the output file.</li>
			<li><span><b>Safe Property - </b>This property accepts Boolean values True and False. It can also be parameterized and later on
				resolved during run-time. The Safe property when True, allows the Output fields to pass evaluation despite of Data type
				mismatch. When False, fields with Data type mismatch will be rejected and the component will abort processing returning an
				error.</li>
			<li><span><b>Character Set - </b>Contains a drop-down of character encoding values. Used simply to denote the encoding system
				followed by the Output file to denote characters of data. Drop down lists values like : UTF8, US-ASCII, ISO-8859-1 etc.</li>
			<li><span><b>Strict - </b>Strict accepts&nbsp;Boolean values True and False. It can also be parameterized and later on resolved
				during run-time. Strict property is used to check if the record structure i.e. number of fields, length of records, scale
				etc are exactly listed by the user as in the Output file. When set to True, the component fails if the record structure
				doesn't match with the one specified by the user. Reverse in case of False.</li>
			<li><span><b>Phase - </b>Phase simply accepts a numeric value starting from 0 to maximum 99 and signifies the phase this component
			will execute in. By default this is 0.</li>
			<li><span><b>Runtime Properties -</b>Runtime properties are used to override the Hadoop configurations specific to Output File
				Fixed Width component at run time. User is required to enter the Property Name and Value in the runtime properties grid.<p>
					<span>Check <a href="../../How To Steps/How_To_Pass_Hadoop_Properties_To_Component.html"> How to pass Hadoop
							properties to component</a></span>
				</p></li>
		</ul>
	</ul>
	<p>
		<img src="../../images/Runtime_Properties_Grid.png" alt="" />
	</p>
	<p><a name="schema_tab"></a><span class="header-2">Schema tab:</span></p>
	<p>
		<img src="../../images/Output_File_Fixed_Width_Properties_Schema.png" alt="" />
	</p>
	<p><span>Schema is <b>mandatory</b> for Output file fixed width component. Schema tab defines the record format on the out port of the Output file fixed width component. A field in schema has multiple attributes as described below.</span></p>
	<ul>
		<li><span><b>Internal - </b>User is provided a Grid to enter the internal schema of the Output Delimited file.</li>
		<ul>
			<li><span><b>Field Name - </b>User needs to enter all the Field names in this column.</li>
			<li><span><b>Data type - </b>By default "string" Data type has been selected for any field added to the Grid. User can select from
				different Data type values like "integer", "double", "float" etc.</li>
			<li><span><b>Date Format - </b>User can specify desired date format like "YY-DD-MM", "YYYYMMDD" etc for a date field in this column.Refer to <a href="../../references/Date_formats.html">Date formats</a> page for acceptable date formats.</li>
			<li><span><b>Precision - </b>Precision for a bigdecimal field can be specified here.</li>
			<li><span><b>Scale - </b>Scale for a bigdecimal field can be specified here.</li>
			<li><span><b>Scale Type - </b>Scale Type accepts values as implicit or explicit for bigdecimal field and none for other data types.
				Explicit considers the length of ' . ' and implicit ignores length of ' . ' for the bigdecimal field.</li>
			<li><span><b>Field Description -</b> User can specify field description.</li>
			<li><span><b>Length - </b>Length denotes the maximum number of characters that a particular Output field may contain.</li>
		</ul>
		<li><span><b>External - </b>User can provide an external Hydrograph Schema file of XML format. A text box is provided to either
			manually type or use the Browse button to select the schema file from File system. The External schema file path is resolved
			during run time and replaced with the contents of the file in the Job XML.</li>
	</ul>
	<p>
		<a name="validations"></a><span class="header-2">Validations</span>
	</p>
	<p>
		<span>The Output file fixed width components applies validations to the mandatory fields. Upon placing the
			Output file fixed width component on job canvas for the first time (from component palette), the component shows up a warning icon as
			mandatory properties are not provided.</span>
	</p>
	<img src="../../images/Output_file_fixed_width_component_validation_warning.png" alt="Warning icon displayed on component" />

	<p>
		<span>The properties window also displays error icon on mandatory fields if it has an incorrect value. The error icon
			is displayed on the tab as well, if any of the field within the tab has some error.</span>
	</p>
	<img src="../../images/Output_file_fixed_width_property_window_validation_error.png" alt="Error icon displayed on tabs" />

	<p>
		<span>If the properties window has some error even after user visit's it once, then the warning icon on the Output file fixed width 
			component on the job canvas changes to error icon. This error icon is removed only when all the mandatory fields are supplied
			with correct values.</span>
	</p>
	<img src="../../images/Output_file_fixed_width_component_validation_error.png" alt="Error icon displayed on component" />
</body>
</html>
